home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / ssbevx.z / ssbevx
Encoding:
Text File  |  2002-10-03  |  8.8 KB  |  265 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSBBBBEEEEVVVVXXXX((((3333SSSS))))                                                          SSSSSSSSBBBBEEEEVVVVXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSBEVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      real symmetric band matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SSBEVX( JOBZ, RANGE, UPLO, N, KD, AB, LDAB, Q, LDQ, VL, VU,
  14.                         IL, IU, ABSTOL, M, W, Z, LDZ, WORK, IWORK, IFAIL, INFO
  15.                         )
  16.  
  17.          CHARACTER      JOBZ, RANGE, UPLO
  18.  
  19.          INTEGER        IL, INFO, IU, KD, LDAB, LDQ, LDZ, M, N
  20.  
  21.          REAL           ABSTOL, VL, VU
  22.  
  23.          INTEGER        IFAIL( * ), IWORK( * )
  24.  
  25.          REAL           AB( LDAB, * ), Q( LDQ, * ), W( * ), WORK( * ), Z( LDZ,
  26.                         * )
  27.  
  28. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  29.      These routines are part of the SCSL Scientific Library and can be loaded
  30.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  31.      directs the linker to use the multi-processor version of the library.
  32.  
  33.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  34.      4 bytes (32 bits). Another version of SCSL is available in which integers
  35.      are 8 bytes (64 bits).  This version allows the user access to larger
  36.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  37.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  38.      only one of the two versions; 4-byte integer and 8-byte integer library
  39.      calls cannot be mixed.
  40.  
  41. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  42.      SSBEVX computes selected eigenvalues and, optionally, eigenvectors of a
  43.      real symmetric band matrix A. Eigenvalues and eigenvectors can be
  44.      selected by specifying either a range of values or a range of indices for
  45.      the desired eigenvalues.
  46.  
  47.  
  48. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  49.      JOBZ    (input) CHARACTER*1
  50.              = 'N':  Compute eigenvalues only;
  51.              = 'V':  Compute eigenvalues and eigenvectors.
  52.  
  53.      RANGE   (input) CHARACTER*1
  54.              = 'A': all eigenvalues will be found;
  55.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  56.              found; = 'I': the IL-th through IU-th eigenvalues will be found.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSBBBBEEEEVVVVXXXX((((3333SSSS))))                                                          SSSSSSSSBBBBEEEEVVVVXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      UPLO    (input) CHARACTER*1
  75.              = 'U':  Upper triangle of A is stored;
  76.              = 'L':  Lower triangle of A is stored.
  77.  
  78.      N       (input) INTEGER
  79.              The order of the matrix A.  N >= 0.
  80.  
  81.      KD      (input) INTEGER
  82.              The number of superdiagonals of the matrix A if UPLO = 'U', or
  83.              the number of subdiagonals if UPLO = 'L'.  KD >= 0.
  84.  
  85.      AB      (input/output) REAL array, dimension (LDAB, N)
  86.              On entry, the upper or lower triangle of the symmetric band
  87.              matrix A, stored in the first KD+1 rows of the array.  The j-th
  88.              column of A is stored in the j-th column of the array AB as
  89.              follows:  if UPLO = 'U', AB(kd+1+i-j,j) = A(i,j) for max(1,j-
  90.              kd)<=i<=j; if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for
  91.              j<=i<=min(n,j+kd).
  92.  
  93.              On exit, AB is overwritten by values generated during the
  94.              reduction to tridiagonal form.  If UPLO = 'U', the first
  95.              superdiagonal and the diagonal of the tridiagonal matrix T are
  96.              returned in rows KD and KD+1 of AB, and if UPLO = 'L', the
  97.              diagonal and first subdiagonal of T are returned in the first two
  98.              rows of AB.
  99.  
  100.      LDAB    (input) INTEGER
  101.              The leading dimension of the array AB.  LDAB >= KD + 1.
  102.  
  103.      Q       (output) REAL array, dimension (LDQ, N)
  104.              If JOBZ = 'V', the N-by-N orthogonal matrix used in the reduction
  105.              to tridiagonal form.  If JOBZ = 'N', the array Q is not
  106.              referenced.
  107.  
  108.      LDQ     (input) INTEGER
  109.              The leading dimension of the array Q.  If JOBZ = 'V', then LDQ >=
  110.              max(1,N).
  111.  
  112.      VL      (input) REAL
  113.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  114.              the interval to be searched for eigenvalues. VL < VU.  Not
  115.              referenced if RANGE = 'A' or 'I'.
  116.  
  117.      IL      (input) INTEGER
  118.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  119.              order) of the smallest and largest eigenvalues to be returned.  1
  120.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  121.              referenced if RANGE = 'A' or 'V'.
  122.  
  123.      ABSTOL  (input) REAL
  124.              The absolute error tolerance for the eigenvalues.  An approximate
  125.              eigenvalue is accepted as converged when it is determined to lie
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSBBBBEEEEVVVVXXXX((((3333SSSS))))                                                          SSSSSSSSBBBBEEEEVVVVXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              in an interval [a,b] of width less than or equal to
  141.  
  142.              ABSTOL + EPS *   max( |a|,|b| ) ,
  143.  
  144.              where EPS is the machine precision.  If ABSTOL is less than or
  145.              equal to zero, then  EPS*|T|  will be used in its place, where
  146.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  147.              AB to tridiagonal form.
  148.  
  149.              Eigenvalues will be computed most accurately when ABSTOL is set
  150.              to twice the underflow threshold 2*SLAMCH('S'), not zero.  If
  151.              this routine returns with INFO>0, indicating that some
  152.              eigenvectors did not converge, try setting ABSTOL to
  153.              2*SLAMCH('S').
  154.  
  155.              See "Computing Small Singular Values of Bidiagonal Matrices with
  156.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  157.              Working Note #3.
  158.  
  159.      M       (output) INTEGER
  160.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  161.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  162.  
  163.      W       (output) REAL array, dimension (N)
  164.              The first M elements contain the selected eigenvalues in
  165.              ascending order.
  166.  
  167.      Z       (output) REAL array, dimension (LDZ, max(1,M))
  168.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  169.              the orthonormal eigenvectors of the matrix A corresponding to the
  170.              selected eigenvalues, with the i-th column of Z holding the
  171.              eigenvector associated with W(i).  If an eigenvector fails to
  172.              converge, then that column of Z contains the latest approximation
  173.              to the eigenvector, and the index of the eigenvector is returned
  174.              in IFAIL.  If JOBZ = 'N', then Z is not referenced.  Note: the
  175.              user must ensure that at least max(1,M) columns are supplied in
  176.              the array Z; if RANGE = 'V', the exact value of M is not known in
  177.              advance and an upper bound must be used.
  178.  
  179.      LDZ     (input) INTEGER
  180.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  181.              'V', LDZ >= max(1,N).
  182.  
  183.      WORK    (workspace) REAL array, dimension (7*N)
  184.  
  185.      IWORK   (workspace) INTEGER array, dimension (5*N)
  186.  
  187.      IFAIL   (output) INTEGER array, dimension (N)
  188.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  189.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  190.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  191.              is not referenced.
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSSSSSBBBBEEEEVVVVXXXX((((3333SSSS))))                                                          SSSSSSSSBBBBEEEEVVVVXXXX((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      INFO    (output) INTEGER
  207.              = 0:  successful exit.
  208.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  209.              > 0:  if INFO = i, then i eigenvectors failed to converge.  Their
  210.              indices are stored in array IFAIL.
  211.  
  212. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  213.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  214.  
  215.      This man page is available only online.
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.